feat(azurite): Enhance connection string generation for network and local access #859
+227
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add functionality to generate Azurite connection strings suitable for direct container-to-container communication within a Docker network, alongside existing local host access. Key changes include: - Introduces `ConnectionStringType` enum to provide distinct Azurite connection strings for different access patterns: - `NETWORK`: Optimized for inter-container communication using network aliases. - `LOCALHOST`: For access from the host machine via exposed ports. - Refactored `get_connection_string` to dispatch based on `ConnectionStringType`. - Improved `get_external_connection_string` to prioritize network aliases nd provide a fallback to host IP. - Added comprehensive unit test (`test_azurite_inter_container_communication_with_network_string`) to verify inter-container connectivity.
…hon 3.9 in CI checks
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #859 +/- ##
=======================================
Coverage ? 81.79%
=======================================
Files ? 14
Lines ? 890
Branches ? 140
=======================================
Hits ? 728
Misses ? 127
Partials ? 35 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #851
This Pull Request enhances the
AzuriteContainerto provide more flexible and robust connection strings, specifically enabling seamless communication between Azurite and other containers within the same Docker network. It also clarifies access from the local host, addressing the need for distinct connection types in containerized testing environments.Key Changes
ConnectionStringTypeenum: This new enum allows specifying the intended access pattern when requesting an Azurite connection string:NETWORK: Optimized for inter-container communication, leveraging Docker network aliases for direct connectivity.LOCALHOST: Designed for access from the host machine, utilizing dynamically exposed ports and the Docker host IP.get_connection_string: The main method now dispatches to the appropriate internal function based on theConnectionStringTypeprovided.get_external_connection_string: This method has been enhanced to intelligently prioritize network aliases for inter-container communication and provide a robust fallback to the Docker host IP for other scenarios.test_azurite_inter_container_communication_with_network_string, has been added to thoroughly validate both network-based and local host-based connection string functionality.AzuriteContainerand the associated example application (network_container.py) have received updated and more detailed docstrings for improved clarity and usage guidance.Testing
To validate these functionalities, the new test case
test_azurite_inter_container_communication_with_network_stringwas introduced. This test specifically verifies:NETWORKconnection string (via its network alias) and performs an operation (e.g., creates a blob container).LOCALHOSTconnection string, confirming data persistence and accessibility.Concerns and Questions
As this is my first contribution to this repository, I've aimed for comprehensive docstrings and clear code. I'm open to feedback on their level of detail, adherence to project conventions, or any other aspect of the implementation.
Please let me know if any further changes or clarifications are needed.